fsm: generate and verify static address diagrams#1179
Conversation
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request enhances the reliability and coverage of the project's state machine documentation. By enforcing deterministic sorting during diagram generation and adding a verification step to the CI pipeline, the changes ensure that documentation remains synchronized with the implementation. Furthermore, the scope of the generated diagrams has been expanded to include critical static address components, improving overall project transparency. Highlights
New Features🧠 You can now enable Memory (public preview) to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Ignored Files
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces automated checks and generation for FSM (Finite State Machine) Mermaid diagrams, including new diagrams for static address deposits and loop-ins. It refactors the state parser to sort transition keys deterministically and support the new FSM selectors. Feedback on the changes includes defining a reusable variable in the Makefile to avoid duplicating the list of FSM files, renaming a local variable in the state parser to prevent shadowing an imported package, and building the parser binary once in the generation script instead of executing go run multiple times to improve performance.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
d17c2ba to
2e80b92
Compare
| ```mermaid | ||
| stateDiagram-v2 |
There was a problem hiding this comment.
The GitHub rendering looks a bit strange, but it renders well in my local GoLand
|
I was also thinking of adding ELK, but it looks like it has licensing problems with GitHub support |
2 participants
Summary
fsm.mdconsistentlymake fsm-checkand run it in CI to detect stale generated diagramsTest
make fsm-check